﻿/*                              
   Copyright 2011 Nils Kopal, Christopher Krüger, Simone Sauer, Dennis Nolte, Uni Duisburg-Essen

   Licensed under the Apache License, Version 2.0 (the "License");
   you may not use this file except in compliance with the License.
   You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
*/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;

namespace Sharebert.LinkLayerLibrary.API
{
    public interface IHeader
    {
        /// <summary>
        /// Parses a network header. Unknown lines of the header will be ignored.
        /// </summary>
        /// <param name="header">The string containing the header</param>
        /// <exception cref="System.ArgumentNullException">header is null</exception>
        /// <exception cref="Sharebert.NetworkLayerLibrary.HeaderException">Invalid header format</exception>
        void Parse(string header);

        /// <summary>
        /// The network header used for sending packets (without trailing \n).
        /// </summary>
        /// <returns>A string containing the formated header</returns>
        string GetHeader();

        /// <summary>
        /// The command or message type of the message.
        /// </summary>
        string Command { get; }

        /// <summary>
        /// The number of bytes of the payload.
        /// </summary>
        long PayLoadLength { get; }
    }
}
